/*
 * Copyright 2007 - The JDPF Project Team (http://www.jdpf.org) 
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 * 
 * http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and 
 * limitations under the License. 
 */
package org.jdpf.core.kernel.elements;

import java.net.URISyntaxException;
import java.util.List;

import org.jdpf.core.kernel.execution.Task;
import org.jdpf.core.plugins.exceptions.PluginException;

/**
 * Transition interface.
 * 
 * @author  Paolo Ciccarese
 */

public interface ITransition extends IWiring {
	
	/**
	 * Returns all the inputs to the transition.
	 */
	public List<Token> getInputs();
	
	/**
	 * Sets all the outputs of the transition.
	 * @param token	Transition output token.
	 */
	public void setOutputs(Token token);
	
	/**
	 * Remove all the input tokens.
	 */	
	public void removeInputTokens();
	
	/**
	 * Returns if the transition is anabled
	 * @return	Transition enabled flag
	 */
	public boolean isEnabled();
	
	/**
	 * Fires the transition. 
	 */
	public void fire(Task task) throws Exception;
	
	/**
	 * Fires the transition with or without processing
	 * @param withAction	Enable process flag
	 */
	public void fire(final boolean withAction, Task task) throws Exception;
	
	/**
	 * Processes the list of tokens and give back a single one.
	 * @throws URISyntaxException 
	 */
	public Token process(List<Token> list) throws PluginException, URISyntaxException;
}
